GET Audios for a specific Podcast
Overview
The following table contains information about the GET method for managing the process of retrieving audios from a specific podcast.
| GET Paginated Audios for a specific Podcast | |
|---|---|
| Method | GET |
| URL or Endpoint | /api/v2/projectId/podcasts/audios |
| Parameters | podcastId(query), page(query), take(query), projectId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| projectId URL Parameter | |
|---|---|
| URL Parameter Name | projectId |
| Mandatory | Yes |
| Type | string |
| Description | Unique Id of the project. |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Description |
|---|---|---|---|
| podcastId | Yes | string | Unique Id of the podcast. |
| page | No | integer($int32) | Current page you want to receive |
| take | No | integer($int32) | Number of channels you want to receive |
Request Body
This method does not require the request body.
Response
{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": {
"currentPage": 0,
"totalPages": 0,
"pageSize": 0,
"totalCount": 0,
"items": [
{
"mediaId": "{audioId}",
"title": "{title}",
"author": "{author}",
"publishDate": "2025-03-11T10:01:36.664Z",
"thumbnailUrl": "https://cdn.vpplayer.tech/{projectId}/audio-encode/{audioId}/thumbnails/retina.jpg",
"duration": 93.727347,
"durationString": "01:33",
"hlsUrl": "https://cdn.vpplayer.tech/{projectId}/audio-encode/{audioId}/hls/master_file.m3u8"
}
]
},
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
| Field Name | Type | Description |
|---|---|---|
| success | bool | If the response is successful it will return true. Otherwise will return false |
| errors | array[] | Indicates if there was an error |
| messages | array[] | Returns the response message from back-end |
| result | array[Object] | Returns the response object |
| currentPage | integer($int32) | Returns the current page number in the paginated list of audio |
| totalPages | integer($int32) | Returns the total number of pages available for the audio list |
| pageSize | integer($int32) | Specifies the maximum number of audios that can be displayed on a single page |
| totalCount | integer($int32) | Returns the total number of audios that are in that page |
| items | array[Object] | Returns the list of podcast's audio objects with detailed information for each audio |
| mediaId | string | The identifier for the audio |
| title | string | The title of the audio |
| author | string | Author of the audio |
| publishDate | string | The date and time when the audio was published |
| thumbnailUrl | string | The URL for the thumbnail image of the audio |
| duration | float | The duration of the audio in seconds |
| durationString | string | The duration of the audio formatted as a string |
| hlsUrl | string | The URL for the HLS version of the audio |
| resultInfo | object | Additional information about the result |
| statusCode | integer | The HTTP status code of the response |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed